/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_HELPERS_SOCKET_INPUT_STREAM_H
#define _LOG4CXX_HELPERS_SOCKET_INPUT_STREAM_H

#include <log4cxx/logstring.h>
#include <log4cxx/helpers/objectimpl.h>
#include <log4cxx/helpers/objectptr.h>
#include <log4cxx/helpers/exception.h>

namespace log4cxx
{
        namespace helpers
        {
                class Socket;
                typedef ObjectPtrT<Socket> SocketPtr;

                class SocketInputStream;
                typedef ObjectPtrT<SocketInputStream> SocketInputStreamPtr;

                class LOG4CXX_EXPORT EOFException : public Exception
                {
                public:
                    EOFException() : Exception("EOF Exception") {}
                };

                class LOG4CXX_EXPORT SocketInputStream : public ObjectImpl
                {
                private:
                        static size_t DEFAULT_BUFFER_SIZE;

                public:
                        DECLARE_ABSTRACT_LOG4CXX_OBJECT(SocketInputStream)
                        BEGIN_LOG4CXX_CAST_MAP()
                                LOG4CXX_CAST_ENTRY(SocketInputStream)
                        END_LOG4CXX_CAST_MAP()

                        SocketInputStream(SocketPtr socket);
                        SocketInputStream(SocketPtr socket, size_t bufferSize);
                        ~SocketInputStream();

                        void read(void * buffer, size_t len) const;
                        void read(unsigned int &value) const;
                        void read(int &value) const;
                        void read(unsigned long &value) const;
                        void read(long &value) const;
                        void read(LogString& value) const;
                        // some read functions are missing ...

                        /** Close the stream and dereference the socket.
                        */
                        void close();

                protected:
                        SocketPtr socket;
                        size_t bufferSize;
                        unsigned char * memBuffer;
                        size_t currentPos;
                        size_t maxPos;

                private:
                        //   prevent copy and assignment statements
                        SocketInputStream(const SocketInputStream&);
                        SocketInputStream& operator=(const SocketInputStream&);
                };
        }  // namespace helpers
} // namespace log4cxx

#endif // _LOG4CXX_HELPERS_SOCKET_OUTPUT_STREAM_H
